Resource URL: /platform/<<version=3>>/cluster/nodes/<LNN>/status

    Overview: This resource applies the standard collection pattern to
              individual nodes.  LNN in the resource path is the node lnn ID.

     Methods: GET

********************************************************************************

Method GET: Retrieve node status information.

       URL: GET /platform/<<version=3>>/cluster/nodes/<LNN>/status

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "total": {
          "type": "integer", 
          "description": "The total number of nodes responding."
        }, 
        "nodes": {
          "items": {
            "type": "object", 
            "description": "Node status information (hardware reported).", 
            "properties": {
              "batterystatus": {
                "type": "object", 
                "description": "Battery status information.", 
                "properties": {
                  "status1": {
                    "type": "string", 
                    "description": "The status of battery 1."
                  }, 
                  "status2": {
                    "type": "string", 
                    "description": "The status of battery 2."
                  }, 
                  "supported": {
                    "type": "boolean", 
                    "description": "Node supports battery status."
                  }, 
                  "result2": {
                    "type": "string", 
                    "description": "The result of the last battery test for battery 2."
                  }, 
                  "result1": {
                    "type": "string", 
                    "description": "The result of the last battery test for battery 1."
                  }, 
                  "next_test_time1": {
                    "type": "string", 
                    "description": "The next checkup for battery 1."
                  }, 
                  "last_test_time1": {
                    "type": "string", 
                    "description": "The last battery test time for battery 1."
                  }, 
                  "last_test_time2": {
                    "type": "string", 
                    "description": "The last battery test time for battery 2."
                  }, 
                  "next_test_time2": {
                    "type": "string", 
                    "description": "The next checkup for battery 2."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "Node has battery status."
                  }
                }
              }, 
              "status": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Status of the HTTP response from this node if not 200.  If 200, this field does not appear.", 
                "maximum": 4294967295
              }, 
              "uptime": {
                "type": "integer", 
                "description": "Seconds this node has been online."
              }, 
              "capacity": {
                "items": {
                  "type": "object", 
                  "description": "Node capacity information.", 
                  "properties": {
                    "count": {
                      "type": "integer", 
                      "description": "Total device count."
                    }, 
                    "type": {
                      "type": "string", 
                      "description": "Device type."
                    }, 
                    "bytes": {
                      "type": "integer", 
                      "description": "Total device storage bytes."
                    }
                  }
                }, 
                "type": "array", 
                "description": "Storage capacity of this node."
              }, 
              "version": {
                "type": "string", 
                "description": "OneFS version."
              }, 
              "powersupplies": {
                "type": "object", 
                "description": "Information about this node's power supplies.", 
                "properties": {
                  "count": {
                    "type": "integer", 
                    "description": "Count of how many power supplies are supported."
                  }, 
                  "status": {
                    "type": "string", 
                    "description": "A descriptive status string for this node's power supplies."
                  }, 
                  "supports_cff": {
                    "type": "boolean", 
                    "description": "Does this node support CFF power supplies."
                  }, 
                  "supplies": {
                    "items": {
                      "type": "object", 
                      "description": "Power supply information.", 
                      "properties": {
                        "status": {
                          "type": "string", 
                          "description": "A descriptive status string for this power supply."
                        }, 
                        "good": {
                          "type": "string", 
                          "description": "Is this power supply in a failure state."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Complete identifying string for this power supply."
                        }, 
                        "firmware": {
                          "type": "string", 
                          "description": "The current firmware revision of this power supply."
                        }, 
                        "chassis": {
                          "type": "integer", 
                          "description": "Which node chassis is this power supply in."
                        }, 
                        "type": {
                          "type": "string", 
                          "description": "The type of this power supply."
                        }, 
                        "id": {
                          "required": true, 
                          "type": "integer", 
                          "description": "Identifying index for this power supply."
                        }
                      }
                    }, 
                    "type": "array", 
                    "description": "List of this node's power supplies."
                  }, 
                  "failures": {
                    "type": "integer", 
                    "description": "Count of how many power supplies have failed."
                  }, 
                  "has_cff": {
                    "type": "boolean", 
                    "description": "Does this node have a CFF power supply."
                  }
                }
              }, 
              "cpu": {
                "type": "object", 
                "description": "CPU status information for this node.", 
                "properties": {
                  "overtemp": {
                    "type": "string", 
                    "description": "CPU overtemp state."
                  }, 
                  "model": {
                    "type": "string", 
                    "description": "Manufacturer model description of this CPU."
                  }, 
                  "proc": {
                    "type": "string", 
                    "description": "Type of processor and core of this CPU."
                  }, 
                  "speed_limit": {
                    "type": "string", 
                    "description": "CPU throttling (expressed as a percentage)."
                  }
                }
              }, 
              "nvram": {
                "type": "object", 
                "description": "Node NVRAM information.", 
                "properties": {
                  "supported_size": {
                    "type": "integer", 
                    "description": "The maximum size of the NVRAM, in bytes."
                  }, 
                  "supported": {
                    "type": "boolean", 
                    "description": "This node supports NVRAM."
                  }, 
                  "charge_status": {
                    "type": "string", 
                    "description": "This node's NVRAM battery charge status, as a color."
                  }, 
                  "present_size": {
                    "type": "integer", 
                    "description": "The size of the NVRAM, in bytes."
                  }, 
                  "present_type": {
                    "type": "string", 
                    "description": "This node's NVRAM type."
                  }, 
                  "ship_mode": {
                    "type": "integer", 
                    "description": "This node's current ship mode state for NVRAM batteries."
                  }, 
                  "batteries": {
                    "items": {
                      "type": "object", 
                      "description": "NVRAM battery status information.", 
                      "properties": {
                        "color": {
                          "type": "string", 
                          "description": "The current status color of the NVRAM battery."
                        }, 
                        "status": {
                          "type": "string", 
                          "description": "The current status message of the NVRAM battery."
                        }, 
                        "id": {
                          "type": "integer", 
                          "description": "Identifying index for the NVRAM battery."
                        }, 
                        "voltage": {
                          "type": "string", 
                          "description": "The current voltage of the NVRAM battery."
                        }
                      }
                    }, 
                    "type": "array", 
                    "description": "This node's NVRAM battery status information."
                  }, 
                  "supported_flash": {
                    "type": "boolean", 
                    "description": "This node supports NVRAM with flash storage."
                  }, 
                  "present_flash": {
                    "type": "boolean", 
                    "description": "This node has NVRAM with flash storage."
                  }, 
                  "device": {
                    "type": "string", 
                    "description": "This node's NVRAM device name with path."
                  }, 
                  "battery_count": {
                    "type": "integer", 
                    "description": "This node's NVRAM battery count."
                  }, 
                  "charge_status_number": {
                    "type": "integer", 
                    "description": "This node's NVRAM battery charge status, as a number."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "This node has NVRAM."
                  }, 
                  "supported_type": {
                    "type": "string", 
                    "description": "This node's supported NVRAM type."
                  }
                }
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this information.", 
                "maximum": 4294967295
              }, 
              "error": {
                "required": false, 
                "type": "string", 
                "description": "Error message, if the HTTP status returned from this node was not 200."
              }, 
              "release": {
                "type": "string", 
                "description": "OneFS release."
              }, 
              "id": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Node ID of the node reporting this information.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "The responses from the individual nodes involved in this request."
        }, 
        "errors": {
          "items": {
            "type": "object", 
            "properties": {
              "status": {
                "minimum": 0, 
                "type": "integer", 
                "description": "HTTP Status code returned by this node.", 
                "maximum": 4294967295
              }, 
              "message": {
                "type": "string", 
                "description": "More detailed description of the error."
              }, 
              "code": {
                "type": "string", 
                "description": "The general meaning of the status code."
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this error.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors."
        }
      }
    }
  ]
}
